Skip to content

Add a gh script that forks, pushes and opens a PR on the fork - #5

Open
jacobcow21 wants to merge 1 commit into
masterfrom
fork-pr-script
Open

jacobcow21 wants to merge 1 commit into
masterfrom
fork-pr-script

Conversation

@jacobcow21

Copy link
Copy Markdown
Owner

Requested by Jacob · project thread

Describe your change

Adds scripts/fork_pr.sh, a small gh script that automates the fork workflow used for #3:

  1. Forks the upstream repo if you don't have a fork yet.
  2. Adds a fork remote and pushes the branch to it.
  3. Opens a pull request against the fork's default branch. gh pr create targets the parent repo for forks by default, so the script always passes --repo <your fork>. It never opens anything upstream.

Usage: scripts/fork_pr.sh <branch> "<title>" [<fork issue number>]. Set DRY_RUN=1 to print the commands without running them.

  • Add an algorithm?
  • Fix a bug or typo in an existing algorithm?
  • Add or change doctests? -- Note: Please avoid changing both code and tests in a single pull request.
  • Documentation change?

Checklist

  • I have read CONTRIBUTING.md.
  • This pull request is all my own work -- I have not plagiarized.
  • I know that pull requests will not be merged if they fail the automated tests.
  • This PR only changes one algorithm file. To ease review, please open separate PRs for separate algorithms.
  • All new Python files are placed inside an existing directory.
  • All filenames are in all lowercase characters with no spaces or dashes.
  • All functions and variable names follow Python naming conventions.
  • All function parameters and return values are annotated with Python type hints.
  • All functions have doctests that pass the automated testing.
  • All new algorithms include at least one URL that points to Wikipedia or another similar explanation.
  • If this pull request resolves one or more open issues, then the description above includes the issue number(s) with a closing keyword: "Fixes #ISSUE-NUMBER".

Generated by Claude Code

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant